home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIPluginInstancePeer.idl < prev    next >
Text File  |  2006-05-08  |  5KB  |  136 lines
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. /**
  39.  * nsIPluginInstancePeer
  40.  *
  41.  * @status DEPRECATED
  42.  *
  43.  * Originally published XPCOM Plugin API is now deprecated
  44.  * Developers are welcome to use NPAPI, please refer to:
  45.  * http://mozilla.org/projects/plugins/
  46.  */
  47.  
  48. #include "nsISupports.idl"
  49. #include "nspluginroot.idl"
  50.  
  51. %{C++
  52. #include "nsplugindefs.h"
  53. struct JSObject;
  54. %}
  55.  
  56. interface nsIOutputStream;
  57.  
  58. /**
  59.  * The nsIPluginInstancePeer interface is the set of operations implemented
  60.  * by the browser to support a plugin instance. When a plugin instance is 
  61.  * constructed, a nsIPluginInstancePeer is passed to its initializer 
  62.  * representing the instantiation of the plugin on the page. 
  63.  *
  64.  * Other interfaces may be obtained from nsIPluginInstancePeer by calling
  65.  * QueryInterface, e.g. nsIPluginTagInfo.
  66.  */
  67. [uuid(4b7cea20-019b-11d2-815b-006008119d7a)]
  68. interface nsIPluginInstancePeer : nsISupports
  69. {
  70.     /**
  71.    * Returns the value of a variable associated with the plugin manager.
  72.    *
  73.    * (Corresponds to NPN_GetValue.)
  74.    *
  75.    * @param aVariable - the plugin manager variable to get
  76.    * @param aValue    - the address of where to store the resulting value
  77.    * @result          - NS_OK if this operation was successful
  78.    */
  79.   void getValue(in nsPluginInstancePeerVariable aVariable, in voidPtr aValue);
  80.   /**
  81.      * Returns the MIME type of the plugin instance. 
  82.      *
  83.      * (Corresponds to NPP_New's MIMEType argument.)
  84.      *
  85.    * @param aMIMEType - resulting MIME type
  86.    * @result          - NS_OK if this operation was successful
  87.      */
  88.   readonly attribute nsMIMEType MIMEType;
  89.  
  90.     /**
  91.      * Returns the mode of the plugin instance, i.e. whether the plugin is
  92.      * embedded in the html, or full page. 
  93.      *
  94.      * (Corresponds to NPP_New's mode argument.)
  95.      *
  96.    * @param result - the resulting mode
  97.    * @result       - NS_OK if this operation was successful
  98.      */
  99.   readonly attribute nsPluginMode mode;
  100.  
  101.     /**
  102.      * This operation is called by the plugin instance when it wishes to send
  103.      * a stream of data to the browser. It constructs a new output stream to which
  104.      * the plugin may send the data. When complete, the Close and Release methods
  105.      * should be called on the output stream.
  106.      *
  107.      * (Corresponds to NPN_NewStream.)
  108.      *
  109.    * @param aType   - MIME type of the stream to create
  110.    * @param aTarget - the target window name to receive the data
  111.    * @param aResult - the resulting output stream
  112.    * @result        - NS_OK if this operation was successful
  113.      */
  114.   void newStream(in nsMIMEType aType, in string aTarget, out nsIOutputStream aResult);
  115.  
  116.     /**
  117.      * This operation causes status information to be displayed on the window
  118.      * associated with the plugin instance. 
  119.      *
  120.      * (Corresponds to NPN_Status.)
  121.      *
  122.    * @param aMessage - the status message to display
  123.    * @result         - NS_OK if this operation was successful
  124.      */
  125.   void showStatus(in string aMessage);
  126.  
  127.     /**
  128.      * Set the desired size of the window in which the plugin instance lives.
  129.      *
  130.    * @param aWidth  - new window width
  131.    * @param aHeight - new window height
  132.    * @result        - NS_OK if this operation was successful
  133.      */
  134.   void setWindowSize(in unsigned long aWidth, in unsigned long aHeight);
  135. };
  136.